Get-RASAVDCustomHost

NAME

Get-RASAVDCustomHost

SYNOPSIS

The cmdlet returns an object of type Azure Virtual Desktop Custom Host.

SYNTAX

Get-RASAVDCustomHost -ProviderId <uint> [-ShowHostsInHostPool <SwitchParameter>] [-SiteId <uint>] [<CommonParameters>]

DESCRIPTION

The cmdlet returns an object of type Azure Virtual Desktop Custom Host.

PARAMETERS


-SiteId <uint>
Site ID from which to retrieve the Azure Virtual Desktop VMSize information.

If the parameter is omitted, the Licensing Server site ID will be used. 

        Required?                    false
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ProviderId <uint>
Provider ID from which to retrieve the Azure Virtual Desktop Custom Host information. 

        Required?                    true
        Position?                    named
        Default value                0
        Accept pipeline input?       false
        Accept wildcard characters?  false

-ShowHostsInHostPool <SwitchParameter>
Show Hosts in existing host pools. 

        Required?                    false
        Position?                    named
        Default value                False
        Accept pipeline input?       false
        Accept wildcard characters?  false

<CommonParameters> 
        This cmdlet supports the common parameters: Verbose, Debug,
        ErrorAction, ErrorVariable, WarningAction, WarningVariable,
        OutBuffer, PipelineVariable, and OutVariable. For more information, see 
        about_CommonParameters documentation.

INPUTS

-none-

OUTPUTS

AVDCustomHost[]

EXAMPLES


---------- EXAMPLE 1 ----------

Get-RASAVDCustomHost -ProviderId 2 | Format-List

Retrieves all the Custom Hosts under Provider with ID 2 from the Licensing Server site.

To retrieve the info from a specific site, specify the -SiteId parameter.

The Format-List cmdlet formats the display output to include all available properties.
---------- EXAMPLE 2 ----------

Get-RASAVDCustomHost -ProviderId 2 -SiteId 1

Retrieves all the Custom Hosts under Provider with ID 2 from site with ID 1.

RELATED LINKS

-none-